home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / g_man / cat3 / ftn / rectwr.z / rectwr
Encoding:
Text File  |  1998-10-20  |  6.6 KB  |  133 lines
  1.  
  2.  
  3.  
  4. rrrreeeeccccttttwwwwrrrr((((3333GGGG))))                                                          rrrreeeeccccttttwwwwrrrr((((3333GGGG))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      rrrreeeeccccttttwwwwrrrr,,,, llllrrrreeeeccccttttwwww - draws a rectangular array of pixels into the frame
  10.      buffer
  11.  
  12. FFFFOOOORRRRTTTTRRRRAAAANNNN 77777777 SSSSPPPPEEEECCCCIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  13.      ssssuuuubbbbrrrroooouuuuttttiiiinnnneeee rrrreeeeccccttttwwwwrrrr((((xxxx1111,,,, yyyy1111,,,, xxxx2222,,,, yyyy2222,,,, ppppaaaarrrrrrrraaaayyyy))))
  14.      iiiinnnntttteeeeggggeeeerrrr****4444 xxxx1111,,,, yyyy1111,,,, xxxx2222,,,, yyyy2222
  15.      iiiinnnntttteeeeggggeeeerrrr****2222 ppppaaaarrrrrrrraaaayyyy((((****))))
  16.  
  17.      ssssuuuubbbbrrrroooouuuuttttiiiinnnneeee llllrrrreeeeccccttttwwww((((xxxx1111,,,, yyyy1111,,,, xxxx2222,,,, yyyy2222,,,, ppppaaaarrrrrrrraaaayyyy))))
  18.      iiiinnnntttteeeeggggeeeerrrr****4444 xxxx1111,,,, yyyy1111,,,, xxxx2222,,,, yyyy2222
  19.      iiiinnnntttteeeeggggeeeerrrr****4444 ppppaaaarrrrrrrraaaayyyy((((****))))
  20.  
  21. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  22.      _x_1       expects the lower-left x coordinate of the rectangular region.
  23.  
  24.      _y_1       expects the lower-left y coordinate of the rectangular region.
  25.  
  26.      _x_2       expects the upper-right x coordinate of the rectangular region.
  27.  
  28.      _y_2       expects the upper-right y coordinate of the rectangular region.
  29.  
  30.      _p_a_r_r_a_y   expects the array which contains the values of the pixels to be
  31.               drawn.  For RGBA values, pack the bits thusly:  $$$$_A_A_B_B_G_G_R_R,
  32.               where:
  33.  
  34.                    _A_A  contains the alpha value,
  35.                    _B_B  contains the blue value,
  36.                    _G_G  contains the green value, and
  37.                    _R_R  contains the red value.
  38.  
  39.               RGBA component values range from 0 to $FF (255).  The alpha
  40.               value will be ignored if blending is not active and the machine
  41.               has no alpha bitplanes.
  42.  
  43. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  44.      rrrreeeeccccttttwwwwrrrr and llllrrrreeeeccccttttwwww draw pixels taken from the array _p_a_r_r_a_y into the
  45.      specified rectangular frame buffer region. The system usually draws
  46.      pixels left-to-right, then bottom-to-top. All coordinates are relative to
  47.      the lower-left corner of the window, not the screen or viewport.
  48.  
  49.      Pixels are written to the currently active framebuffer, as specified by
  50.      ddddrrrraaaawwwwmmmmoooo.  Thus, to write pixel values to the overlay bitplanes, for
  51.      example, simply set ddddrrrraaaawwwwmmmmoooo to OOOOVVVVEEEERRRRDDDDRRRR.
  52.  
  53.      The number of pixels in _p_a_r_r_a_y is always (x2-x1+1) * (y2-y1+1). If the
  54.      zoom factors set by rrrreeeeccccttttzzzzoooo are both 1.0, the screen region _x_1 through _x_2,
  55.      _y_1 through _y_2, are filled.  Other zoom factors result in filling past _x_2
  56.      and/or past _y_2 (_x_1,_y_1 is always the lower-left corner of the filled
  57.      region).
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. rrrreeeeccccttttwwwwrrrr((((3333GGGG))))                                                          rrrreeeeccccttttwwwwrrrr((((3333GGGG))))
  71.  
  72.  
  73.  
  74.      rrrreeeeccccttttwwwwrrrr draws an array of 16-bit words, and therefore should be used only
  75.      to write color index values.  llllrrrreeeeccccttttwwww draws an array of 32-bit words.
  76.      Based on the current ppppiiiixxxxmmmmoooodddd, llllrrrreeeeccccttttwwww can draw pixels of 1, 2, 4, 8, 12,
  77.      16, 24, or 32 bits each.  Use it to write packed RGB or RGBA values,
  78.      color index values, or _z values.
  79.  
  80.      ppppiiiixxxxmmmmoooodddd affects the operation of llllrrrreeeeccccttttwwww substantialy, and has no effect on
  81.      the operation of rrrreeeeccccttttwwwwrrrr.  By default, llllrrrreeeeccccttttwwww draws 32-bit pixels in the
  82.      format used by ccccppppaaaacccckkkk.  Different pixel sizes, framebuffer shifts, scan
  83.      patterns through the framebuffer, and strides through memory, can all be
  84.      specified using ppppiiiixxxxmmmmoooodddd.
  85.  
  86.      rrrreeeeccccttttwwwwrrrr and llllrrrreeeeccccttttwwww leave the current character position unpredictable.
  87.  
  88. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  89.      blendf, dither, lrectr, pixmod, rectco, rectzo
  90.  
  91. NNNNOOOOTTTTEEEESSSS
  92.      These routines are available only in immediate mode.
  93.  
  94.      On IRIS Indigo, Indy, and XL graphics the pixels written by rrrreeeeccccttttwwwwrrrr and
  95.      llllrrrreeeeccccttttwwww will be dithered if dithering is enabled.  To write undithered
  96.      pixels the ddddiiiitttthhhheeeerrrr command must be used to turn dithering off.  On the
  97.      Indigo, if dithering is on, pixel images written, then read and written
  98.      again will cause successive dithering to be done each time the pixels are
  99.      written.  On Indy and XL graphics, successive dithering will not occur.
  100.  
  101.      On Indigo Entry graphics, when in color index mode with double-buffering
  102.      enabled, 8-bit values are clamped to 4 bits, rather than being masked.
  103.  
  104. BBBBUUUUGGGGSSSS
  105.      IRIS-4D Personal Iris requires that both |x2-x1| and |y2-y1| be less than
  106.      2048.
  107.  
  108.      IRIS-4D VGX and VGXT require that both |x2-x1+1| and |y2-y1+1| be less
  109.      than 2048.
  110.  
  111.      The size of the array passed to rrrreeeeccccttttwwwwrrrr is limited to the size of the
  112.      screen.
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.